Installing and Updating CygNet Bridge

CygNet Bridge provides secure data access from outside of your CygNet production environment when using companion products such as CygNet Mobile, CygNet Dispatch, and CygNet Bridge API.

Install CygNet Bridge as the link between your CygNet installation and your additional enterprise applications, to serve as a secure intermediary connection. Each CygNet Bridge installation accommodates a specific access configuration.

CygNet Bridge is required to run CygNet Mobile, CygNet Dispatch, and CygNet Bridge API.

See CygNet Mobile, CygNet Dispatch, or CygNet Bridge API for general information about those components.

CygNet Bridge Log Files

CygNet Bridge log files are found in the following default storage location (if not changed during CygNet Bridge installation).

Install CygNet Bridge

Accomplish all prerequisite system preparation tasks before attempting to install CygNet Bridge. See Preparing Your System for CygNet Bridge for more information.

After you have prepared your server and system to meet all requirements, install and configure CygNet Bridge as follows, for each instance of CygNet Bridge required.

To Install CygNet Bridge

  1. Ensure that all prerequisite steps are complete, including prerequisites for each CygNet Bridge companion product feature you will be installing. This ensures that your system components and CygNet SCADA installation are prepared to interoperate with CygNet Bridge. See Preparing your System for CygNet Bridge for more information.
  2. Obtain the product source files from the CygNet Download Site (login required).
  3. Extract the source files from the .zip file.
  4. Install and run CygNet Bridge Setup (CygNet Bridge Setup.exe).
    1. Copy the CygNet Bridge Setup.exe file to the staging location on the computer where you plan to install the CygNet Bridge software.
    2. Right-click the CygNet Bridge Setup icon and choose Run as administrator to launch the installation wizard.
    3. When the installation wizard appears, read the license terms and conditions, check the I agree to the license terms and conditions box to agree, and then click Next to proceed.

      Note: The installer will verify that you have installed the required features or components and prompt you to correct any omissions. For some of the items, you may need to restart your system, then restart the installation process.

    4. On the System Validation page, verify listed features, or fix/install any features as needed. When the list is in compliance, click Next.
    5. On the Feature Selection page, select features and options to install. When the features are selected, click Next.
      1. In the Feature Selection section, select the features to install by clicking each check box next to the Mobile, Dispatch, and/or Bridge API options you will be installing.
      2. In the Supplemental Options section, select the desired communications protocol. HTTPS is the default selection and is strongly recommended for secure communications. If you select HTTPS, type the name of your HTTPS host for CygNet Bridge into the HTTPS host name text box.

        Note: It is strongly recommended to use the HTTPS (https://*) secure option because HTTPS traffic is encrypted from end to end, helping to ensure that data transmitted between the web server and your CygNet installation is more secure; HTTP is not secure and is not safe for production environments.

      3. In the Port binding section, enter the desired port number to bind to. 80 is the default value. If you enter an alternative port selection, the system will validate your entry to ensure that the port number is valid.
    6. On the Mobile page (if you are installing the CygNet Mobile feature), configure the following settings. When the Mobile settings are complete, click Next.
      • In the Mobile Security (ACS) section, enter your connection information.
        • In the CygNet Domain field, enter the domain of the CygNet system containing the ACS you want to use.
        • In the CygNet Access Control Service field, enter the name of the site and service Site.Service to be used, e.g. CYGNET.ACS.
      • In the Mobile Settings Storage (GRP) section, enter your connection information.
        • In the CygNet Domain field, enter the domain of the CygNet system containing the GRP service you want to use.
        • In the CygNet Group Service field, enter the name of the site and service Site.Service to be used, e.g. CYGNET.GRP.

          • Note: This Group Service is for CygNet Mobile settings, and should be distinct from any Group Service used for hierarchy storage.

    7. On the Dispatch page (if you are installing the CygNet Dispatch feature), configure the following settings. When the Dispatch settings are complete, click Next.
      • In the Dispatch (FMS) section, enter your connection information.
        • In the CygNet Domain field, enter the domain of the CygNet system containing the FMS you want to use.
        • In the CygNet Dispatch Service field, enter the name of the site and service Site.Service to be used, e.g. CYGNET.FMS.
      • In the Application Blob Service (APPS) section, enter your connection information.
        • In the CygNet Domain field, enter the domain of the CygNet system containing the APPS you want to use
        • In the CygNet Application Blob Service field, enter the name of the site and service Site.Service to be used, e.g. CYGNET.APPS.
    8. On the Bridge API page (if you are installing the CygNet Bridge API feature), configure the following settings. When the Bridge API settings are complete, click Next.
      • In the Bridge API Security (ACS) section, enter your connection information.
        • In the CygNet Domain field, enter the domain of the CygNet system containing the ACS you want to use.
        • In the CygNet Access Control Service field, enter the name of the site and service Site.Service to be used, e.g. CYGNET.ACS.
      • In the Allowed Domains section, enter information specifying your accessible domains.
        • In the Comma-separated list of CygNet domains field, enter the domains you want to be allowed access by Bridge API.

          Example: 5432, 6543, 7654

      • In the Relative Facility Definition File Path section, enter your file storage information.
        • In the Blob path of file containing Relative Facility definitions field, enter the Blob path for the location where the definition file is stored. This file is required to use Relative Facility functionality, and could be a standard RelativeFacilityDefs.xml file stored in the BSS or, if you are using Canvas and have generated a global settings file that is stored in the BSS, it could be the GlobalSettings.gsf file containing relative facility definitions.

          Examples:

          [5432]CYGNET.BSS\Bridge\RelativeFacilityDefs.xml — relative facility definitions in .xml file format; standalone file for CygNet Bridge

          [5432]CYGNET.BSS\Canvas\GlobalSettings.gsf — relative facility definitions in .gsf file format; Canvas file shared with CygNet Bridge

      • In the Multi-factor authentication section, select a mode for two-factor authentication, if used, and then enter data storage information for the Group service (GRP type) to use for authentication information. See Providing Two-Factor Authentication in the CygNet Bridge API section for more information about these options.
        • In the Two-factor mode field, select an option from the drop-down menu. Options are Disabled, Optional, and Required. Default value is Disabled.
        • If not disabled, in the CygNet Domain field, enter the domain of the CygNet system containing the dedicated Group service for user authentication information.
        • If not disabled, in the CygNet Group Service field, enter the name of the site and service Site.Service of the Group service to use, e.g. CYGNET.USER2FA.
    9. On the Program Folder page, specify an installation folder for storing your CygNet Bridge files.
      • The default location is C:\Weatherford\CygNetBridge.
      • In the Program Folder field, select or enter a location for the software,
      • Click Install.
    10. Once the software installation is successful, exit the installer. Note and complete any instructions provided at the end of the installation process, before proceeding to launch the software.

Start CygNet Bridge

Any time you finish installing or reinstalling CygNet Bridge, complete the following steps to initialize and launch the software.

To Start CygNet Bridge

  1. Open the Internet Information Services (IIS) Manager.
  2. In the Connections pane, select your host in the tree and expand the Sites node to view the sites present. You should see CygNet Bridge and Default Website.
  3. At the bottom of the center pane, select the Features View page to view the status for your sites.
    1. Locate Default Website in the list and confirm the status.
      1. If the Default Website status is "Started" right-click Default Website and select Manage Website > Stop to stop the site and avoid a port collision.
      2. If the Default Website status is "Stopped" leave it as is.
    2. Locate CygNet Bridge in the list to confirm the site is installed.
      1. Right-click CygNet Bridge and select Manage Website > Start to start the site.
  1. To use HTTPS (strongly recommended), configure the HTTPS binding, if you have not already done so. See Activating HTTPS for more information.
  2. If using CygNet Mobile or CygNet Dispatch, confirm the services making up CygNet Bridge are operational, as follows.
    1. In the IIS Connections pane, under the CygNet Bridge site, right-click the Diagnostics node and then select Manage Application > Browse to launch the Web Diagnostics application.
    2. In the Diagnostics application, click Service Status to view a list of your services and confirm all web services are active. It may take a few moments for all of the services to start.
      • If one service or more is not running, use the Diagnostics application to check its status.
      • Information is provided in the status table for services that are down, to help you troubleshoot and fix any issues found.
      • When all services are up and running, confirm service status in the table again to verify that all are active.
    3. Exit the Diagnostics application.

Update CygNet Bridge

CygNet Bridge can be updated any time a new application version is released. Install new CygNet Bridge files as follows.

  1. Stop CygNet Bridge in your IIS Manager.

  2. Obtain the product source files from the CygNet Download Site (login required).

  3. Extract the source files from the .zip file.
  4. Copy the new CygNet Bridge Setup.exe file to the staging location on the computer where you previously installed CygNet Bridge.
  5. Open the CygNet Bridge installer, and follow the prompts to install the software.
  6. Start CygNet Bridge in your IIS Manager.